gh-101100: Fix some Sphinx reference warnings in whatsnew/2.6.rst#139236
gh-101100: Fix some Sphinx reference warnings in whatsnew/2.6.rst#139236AA-Turner merged 11 commits intopython:mainfrom
Conversation
Also add a working link for abc.abstractmethod while there
|
All commit authors signed the Contributor License Agreement. |
bedevere-app
bot
added
awaiting review
docs
rowanbudge
changed the title
rowanbudge
changed the title
|
@rowanbudge Looks like the CLA bot still needs appeasing. Please can you check it's signed with the same email address mentioned in the comment? |
I think this is done now, not sure when the github accounts got switched sorry! |
Doc/whatsnew/2.6.rst
Outdated
| and :meth:`close`. | ||
| * :class:`~io.RawIOBase` defines raw I/O operations: :meth:`~io.RawIOBase.read`, | ||
| :meth:`~io.RawIOBase.readinto`, | ||
| :meth:`~io.RawIOBase.write`, :meth:`~io.IOBase.seek`, :meth:`~io.IOBase.tell`, :meth:`~io.IOBase.truncate`, |
There was a problem hiding this comment.
Please wrap lines to 79 characters.
There was a problem hiding this comment.
I've wrapped at 79 lines in all the places already edited by this PR that I could spot
There was a problem hiding this comment.
Thanks, however, it introduced a lot of trailing white space causing the lint CI to fail.
There was a problem hiding this comment.
Yep aware and working on it
There was a problem hiding this comment.
On the other hand, rewrapping all edits makes it harder to review the actual changes in the diff, so it's a balance. (There's some discussion in python/devguide#1018.)
No need to unwrap though.
Also please avoid force-pushing -- everything gets squashed into a single commit at the end, and separate commits are easier to review. Thanks!
rowanbudge
force-pushed
the
fix-sphinx-warnings-in-whatsnew-2.6
branch
from
de1a24b to
63b5bd2
Compare
now with pre-commit check to remove whitespace
rowanbudge
force-pushed
the
fix-sphinx-warnings-in-whatsnew-2.6
branch
from
b57ba9e to
3c94412
Compare
Hopefully also resolve Block quote ends without a blank line; unexpected unindent.
AA-Turner
changed the title
AA-Turner
left a comment
AA-Turner
left a comment
There was a problem hiding this comment.
Is this PR intended to resolve all warnings in the file? It's OK if not, just trying to get a sense of intended scope for the review.
A
|
No, not all, just one sprint day's worth :) We can fix the rest in future PRs. |
AA-Turner
added
needs backport to 3.13
|
Thanks @rowanbudge for the PR, and @AA-Turner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14. |
….rst`` (pythonGH-139236) (cherry picked from commit 04a2f80) Co-authored-by: rowanbudge <rowanbudge@gmail.com> Co-authored-by: rowanvil <rowan@anvil.works> Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
….rst`` (pythonGH-139236) (cherry picked from commit 04a2f80) Co-authored-by: rowanbudge <rowanbudge@gmail.com> Co-authored-by: rowanvil <rowan@anvil.works> Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
|
GH-139568 is a backport of this pull request to the 3.14 branch. |
|
GH-139569 is a backport of this pull request to the 3.13 branch. |
|
Thanks for this PR @rowanbudge and congratulations on your first contribution! A |
…6.rst`` (python#139236) Co-authored-by: rowanvil <rowan@anvil.works> Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
…6.rst`` (GH-139236) (#139569) gh-101100: Fix some Sphinx reference warnings in ``whatsnew/2.6.rst`` (GH-139236) (cherry picked from commit 04a2f80) Co-authored-by: rowanbudge <rowanbudge@gmail.com> Co-authored-by: rowanvil <rowan@anvil.works> Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
5 participants
For gh-101100 - Fix all Sphinx reference warnings in the documentation #101100
Fix some of the issues in whatsnew/2.6.rst
Part of sprints at PyConUK 25
📚 Documentation preview 📚: https://cpython-previews--139236.org.readthedocs.build/